Added facade methods documentation for better developer guidance #466
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
I have added documentation for methods accessible from the facades. This will help the developer to know exactly what methods the facade has, including their return and parameters.
Before:
![image](https://private-user-images.githubusercontent.com/39843954/389468031-ed8f9049-94cc-4259-bfea-7e9a5db79816.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkwMTczNDAsIm5iZiI6MTczOTAxNzA0MCwicGF0aCI6Ii8zOTg0Mzk1NC8zODk0NjgwMzEtZWQ4ZjkwNDktOTRjYy00MjU5LWJmZWEtN2U5YTVkYjc5ODE2LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAyMDglMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMjA4VDEyMTcyMFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTE5ZDY5NmFlNTBhYjBhOTk1NjQ2YTMwNjIwOGE5ZTgzNTgwODIwZjJmNzlhMjI1YmVjZjBiMWJkYTFlM2M1OTYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.GleS2Cs_V7T9SBakB6k741bedcsLYElwFTvCMBVFssU)
After:
![image](https://private-user-images.githubusercontent.com/39843954/389468346-9f9b31c9-2ad7-4ecb-a1f8-fe10cdfc8c60.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkwMTczNDAsIm5iZiI6MTczOTAxNzA0MCwicGF0aCI6Ii8zOTg0Mzk1NC8zODk0NjgzNDYtOWY5YjMxYzktMmFkNy00ZWNiLWExZjgtZmUxMGNkZmM4YzYwLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAyMDglMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMjA4VDEyMTcyMFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTUwMmViZDg1MGM2NDZmZDYyMmZjZWZkZGM1YzcyYTk4YjM2NGNjODA4ODBlMGViMDZhNDlkN2Y2M2I1OTllMzEmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.PoKKoXnFrXzozzgDSBmpkrb6XMa9vwP1VZCWXcuk9D8)
References
Testing
Contributor Checklist